Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc: Remove title text from internal links #98409

Merged
merged 1 commit into from
Oct 19, 2022
Merged

Doc: Remove title text from internal links #98409

merged 1 commit into from
Oct 19, 2022

Conversation

rffontenelle
Copy link
Contributor

Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators

Please backport it to 3.11 and 3.10 as well.

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 18, 2022
@CAM-Gerlach CAM-Gerlach added needs backport to 3.10 only security fixes 3.10 only security fixes needs backport to 3.11 only security fixes skip issue labels Oct 18, 2022
CAM-Gerlach
CAM-Gerlach reviewed Oct 18, 2022
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM; two suggested fixes on the lines being changed.

Doc/whatsnew/3.10.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.10.rst Outdated Show resolved Hide resolved
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 18, 2022
Merged
@cpython-cla-bot
Copy link

cpython-cla-bot bot commented Oct 19, 2022 •
edited
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@rffontenelle
Doc: Remove title text from internal links
c2bd9c0 
Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators
@rffontenelle
Copy link
Contributor Author

rffontenelle commented Oct 19, 2022 •
edited
Loading

@CAM-Gerlach Thanks for your suggestions. I added them and force-pushed the commit update (accidentally first with wrong author e-mail).

CAM-Gerlach
CAM-Gerlach approved these changes Oct 19, 2022
View reviewed changes
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @rffontenelle

@CAM-Gerlach
Copy link
Member

Thanks @rffontenelle . Just FYI, to avoid all that trouble in the future, you can just go to the Files tab, click Add to batch on the suggestions you want to apply and then click Commit to apply them (with a message of your choosing). This automatically applies the reviewers suggestions and resolves the corresponding review comments with just a couple clicks, which is much easier for you, also avoids mistakes as well as rebasing which many reviewers aren't too fond of (since it will all get squash-merged anyway).

@JelleZijlstra JelleZijlstra merged commit 52fcba6 into python:main Oct 19, 2022
@miss-islington
Copy link
Contributor

Thanks @rffontenelle for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@miss-islington
Copy link
Contributor

Sorry @rffontenelle and @JelleZijlstra, I had trouble checking out the 3.11 backport branch.
Please backport using cherry_picker on command line.
cherry_picker 52fcba651288ac1c0f9b1fb71379f1dad54ee1da 3.11

@bedevere-bot
Copy link

GH-98451 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Oct 19, 2022
@JelleZijlstra JelleZijlstra added needs backport to 3.11 only security fixes and removed needs backport to 3.11 only security fixes labels Oct 19, 2022
@miss-islington
Copy link
Contributor

Thanks @rffontenelle for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 19, 2022
@rffontenelle @miss-islington
Doc: Remove title text from internal links (pythonGH-98409)
8263f18 
Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators
(cherry picked from commit 52fcba6)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@bedevere-bot
Copy link

GH-98452 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 19, 2022
@rffontenelle @miss-islington
Doc: Remove title text from internal links (pythonGH-98409)
241c883 
Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators
(cherry picked from commit 52fcba6)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 19, 2022
@rffontenelle rffontenelle deleted the patch-1 branch October 19, 2022 15:38
miss-islington added a commit that referenced this pull request Oct 19, 2022
@miss-islington @rffontenelle
Doc: Remove title text from internal links (GH-98409)
f0c0d30 
Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators
(cherry picked from commit 52fcba6)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Oct 19, 2022
@miss-islington @rffontenelle
Doc: Remove title text from internal links (GH-98409)
ac2e7be 
Rely on the title of the linked internal page instead of putting the title. Sphinx will render with the title correctly, and this will reduce work for translators
(cherry picked from commit 52fcba6)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
carljm added a commit to carljm/cpython that referenced this pull request Oct 20, 2022
@carljm
Merge branch 'main' into typewatch
8bba5da 
* main: (40 commits)
  pythongh-98461: Fix source location in comprehensions bytecode (pythonGH-98464)
  pythongh-98421: Clean Up PyObject_Print (pythonGH-98422)
  pythongh-98360: multiprocessing now spawns children on Windows with correct argv[0] in virtual environments (pythonGH-98462)
  CODEOWNERS: Become a typing code owner (python#98480)
  [doc] Improve logging cookbook example. (pythonGH-98481)
  Add more tkinter.Canvas tests (pythonGH-98475)
  pythongh-95023: Added os.setns and os.unshare functions (python#95046)
  pythonGH-98363: Presize the list for batched() (pythonGH-98419)
  pythongh-98374: Suppress ImportError for invalid query for help() command. (pythongh-98450)
  typing tests: `_overload_dummy` raises `NotImplementedError`, not `RuntimeError` (python#98351)
  pythongh-98354: Add unicode check for 'name' attribute in _imp_create_builtin (pythonGH-98412)
  pythongh-98257: Make _PyEval_SetTrace() reentrant (python#98258)
  pythongh-98414: py.exe launcher does not use defaults for -V:company/ option (pythonGH-98460)
  pythongh-98417: Store int_max_str_digits on the Interpreter State (pythonGH-98418)
  Doc: Remove title text from internal links (python#98409)
  [doc] Refresh the venv introduction documentation, and correct the statement about VIRTUAL_ENV (pythonGH-98350)
  Docs: Bump sphinx-lint and fix unbalanced inline literal markup (python#98441)
  pythongh-92886: Replace assertion statements in `handlers.BaseHandler` to support running with optimizations (`-O`) (pythonGH-93231)
  pythongh-92886: Fix tests that fail when running with optimizations (`-O`) in `_test_multiprocessing.py` (pythonGH-93233)
  pythongh-92886: Fix tests that fail when running with optimizations (`-O`) in `test_py_compile.py` (pythonGH-93235)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CAM-Gerlach CAM-Gerlach CAM-Gerlach approved these changes

@JelleZijlstra JelleZijlstra Awaiting requested review from JelleZijlstra

Assignees

@JelleZijlstra JelleZijlstra

Labels
3.10 only security fixes docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rffontenelle @CAM-Gerlach @miss-islington @bedevere-bot @JelleZijlstra